-
Notifications
You must be signed in to change notification settings - Fork 4k
.Net: Example of Semantic Caching with Filters #6151
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 tasks
westey-m
approved these changes
May 8, 2024
dotnet/src/Connectors/Connectors.Memory.AzureCosmosDBMongoDB/AzureCosmosDBMongoDBMemoryStore.cs
Show resolved
Hide resolved
westey-m
approved these changes
May 8, 2024
markwallace-microsoft
approved these changes
May 8, 2024
LudoCorporateShark
pushed a commit
to LudoCorporateShark/semantic-kernel
that referenced
this pull request
Aug 25, 2024
### Motivation and Context <!-- Thank you for your contribution to the semantic-kernel repo! Please help reviewers and future users, providing the following information: 1. Why is this change required? 2. What problem does it solve? 3. What scenario does it contribute to? 4. If it fixes an open issue, please link to the issue here. --> This example shows how to achieve Semantic Caching with Filters. `IPromptRenderFilter` is used to get rendered prompt and check in cache if similar prompt was already answered. If there is a record in cache, then previously cached answer will be returned to the user instead of making a call to LLM. If there is no record in cache, a call to LLM will be performed, and result will be cached together with rendered prompt. `IFunctionInvocationFilter` is used to update cache with rendered prompt and related LLM result. Example includes in-memory, Redis and Azure Cosmos DB for MongoDB as caching stores. Common output which demonstrates that second execution is faster, because the result is returned from cache: ``` First run: What's the tallest building in New York? Elapsed Time: 00:00:03.828 Second run: What is the highest building in New York City? Elapsed Time: 00:00:00.541 Result 1: The tallest building in New York is One World Trade Center, also known as Freedom Tower. It stands at 1,776 feet (541.3 meters) tall, including its spire. Result 2: The tallest building in New York is One World Trade Center, also known as Freedom Tower. It stands at 1,776 feet (541.3 meters) tall, including its spire. ``` PR also contains a couple of fixes in Azure Cosmos DB for MongoDB connector and a couple of additions in public API: 1. Added `FunctionResult? Result` property to `PromptRenderContext`. By default it's `null`, because at prompt rendering stage there is no available result yet. But it's possible to set result with some value - in this case, prompt won't be sent to LLM. Instead, the result from filter will be returned. 2. Added `string? RenderedPrompt` to `FunctionResult` type as `Experimental`. By default it's `null`, and will be populated only when `KernelFunctionFromPrompt` is executed. This property will provide a couple of benefits: - It's an additional way how to observe rendered prompt which was sent to LLM during function invocation (today, it's possible to see it only through filter or trace logging). - Rendered prompt will be also available in function invocation/automatic function invocation filters, which is required for caching scenarios to store rendered prompt and LLM result together. ### Contribution Checklist <!-- Before submitting this PR, please make sure: --> - [x] The code builds clean without any errors or warnings - [x] The PR follows the [SK Contribution Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [x] All unit tests pass, and I have added new tests where possible - [x] I didn't break anyone 😄
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
kernel.core
kernel
Issues or pull requests impacting the core kernel
memory
.NET
Issue or Pull requests regarding .NET code
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
This example shows how to achieve Semantic Caching with Filters.
IPromptRenderFilter
is used to get rendered prompt and check in cache if similar prompt was already answered. If there is a record in cache, then previously cached answer will be returned to the user instead of making a call to LLM. If there is no record in cache, a call to LLM will be performed, and result will be cached together with rendered prompt.IFunctionInvocationFilter
is used to update cache with rendered prompt and related LLM result.Example includes in-memory, Redis and Azure Cosmos DB for MongoDB as caching stores.
Common output which demonstrates that second execution is faster, because the result is returned from cache:
PR also contains a couple of fixes in Azure Cosmos DB for MongoDB connector and a couple of additions in public API:
FunctionResult? Result
property toPromptRenderContext
. By default it'snull
, because at prompt rendering stage there is no available result yet. But it's possible to set result with some value - in this case, prompt won't be sent to LLM. Instead, the result from filter will be returned.string? RenderedPrompt
toFunctionResult
type asExperimental
. By default it'snull
, and will be populated only whenKernelFunctionFromPrompt
is executed. This property will provide a couple of benefits:Contribution Checklist